Reads data from an EtherCAT slave's register.
Namespace: IntervalZero.KINGSTAR.Local.Api
Assembly: IntervalZero.KINGSTAR.Local.Api (in IntervalZero.KINGSTAR.Local.dll) Version: 4.4.0.0
Syntax
public KsCommandStatus<byte[]> ReadSlaveRegister(
int SlaveId,
int Offset,
int Length
)Public Function ReadSlaveRegister(
SlaveId As Integer,
Offset As Integer,
Length As Integer
) As KsCommandStatus(Byte())Parameters
SlaveId
Type: int
The slave index. This index value is automatically assigned by the KINGSTAR master when the EtherCAT network starts, based on the physical connection order. The first device connected directly to the master is assigned Index 0, followed by Index 1, Index 2, and so on. These indexes remain consistent within the slave array even if devices are added, removed, or reconnected. Please refer to the use cases in HotConnect, Repair, and Restart for more details.
Offset
Type: int
The offset of the register to read.
Length
Type: int
The length in byte of the data to read.
Return value
Type: KsCommandStatus<byte[]>
Returns the KsCommandStatus class and a byte array.
Remarks
Used to check a slave register during slave development.
IMPORTANT: This method is meant for slave development only. Otherwise, do not use it.
NOTE: This method uses a slow access method that should not be called in the cyclic callback, or it causes a deadlock.
Usable EtherCAT states
ecatInit, ecatPreOP, ecatSafeOP, ecatOP
Examples
N/A
See also